<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XMP Toolkit SDK: public/include/XMP.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xmp_tagline_small.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">XMP Toolkit SDK
   &#160;<span id="projectnumber">6.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('XMP_8hpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">XMP.hpp File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Overall header file for the XMP Toolkit.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="XMP__Environment_8h_source.html">XMP_Environment.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="XMP__Version_8h_source.html">XMP_Version.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="TXMPMeta_8hpp_source.html">TXMPMeta.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="TXMPIterator_8hpp_source.html">TXMPIterator.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="TXMPUtils_8hpp_source.html">TXMPUtils.hpp</a>&quot;</code><br />
</div>
<p><a href="XMP_8hpp_source.html">Go to the source code of this file.</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Overall header file for the XMP Toolkit. </p>
<p>This is an overall header file, the only one that C++ clients should include.</p>
<p>The full client API is in the <code><a class="el" href="TXMPMeta_8hpp.html" title="API for access to the XMP Toolkit core services.">TXMPMeta.hpp</a></code>, <code><a class="el" href="TXMPIterator_8hpp.html" title="API for access to the XMP Toolkit iteration services.">TXMPIterator.hpp</a></code>, <code><a class="el" href="TXMPUtils_8hpp.html" title="API for access to the XMP Toolkit utility services.">TXMPUtils.hpp</a></code> headers. Read these for information, but do not include them directly. The <code>TXMP</code>... classes are C++ template classes that must be instantiated with a string class such as <code>std::string</code>. The string class is used to return text strings for property values, serialized XMP, and so on. Clients must also compile <code>XMP.incl_cpp</code> to ensure that all client-side glue code is generated. This should be done by including it in exactly one client source file.</p>
<p>There are two C preprocessor macros that simplify use of the templates:</p>
<ul>
<li><code>TXMP_STRING_TYPE</code> - Define this as the string class to use with the template. You will get the template headers included and typedefs (<code>SXMPMeta</code>, and so on) to use in your code.</li>
</ul>
<ul>
<li><code>TXMP_EXPAND_INLINE</code> - Define this as 1 if you want to have the template functions expanded inline in your code. Leave it undefined, or defined as 0, to use out-of-line instantiations of the template functions. Compiling <code>XMP.incl_cpp</code> generates explicit out-of-line instantiations if <code>TXMP_EXPAND_INLINE</code> is off.</li>
</ul>
<p>The template parameter, class <code>tStringObj</code>, must have the following member functions (which match those for <code>std::string</code>):</p>
<pre>
 tStringObj&amp; assign ( const char * str, size_t len )
 size_t size() const
 const char * c_str() const
</pre><p>The string class must be suitable for at least UTF-8. This is the encoding used for all general values, and is the default encoding for serialized XMP. The string type must also be suitable for UTF-16 or UTF-32 if those serialization encodings are used. This mainly means tolerating embedded 0 bytes, which <code>std::string</code> does. </p>

<p class="definition">Definition in file <a class="el" href="XMP_8hpp_source.html">XMP.hpp</a>.</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_f832923ad3cb060bc87ad85e68b8a1c3.html">public</a></li><li class="navelem"><a class="el" href="dir_0fb2101ba02d68f078970216a1fe0334.html">include</a></li><li class="navelem"><a class="el" href="XMP_8hpp.html">XMP.hpp</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
